home *** CD-ROM | disk | FTP | other *** search
/ Whiteline: Alpha / Whiteline Alpha.iso / progtool / c / gcc / gdb36p4b.zoo / readline / doc / readline.info < prev   
Encoding:
GNU Info File  |  1993-10-05  |  55.8 KB  |  1,606 lines
  1. This is Info file readline.info, produced by Makeinfo-1.55 from the
  2. input file rlman.texinfo.
  3.  
  4.    This document describes the GNU Readline Library, a utility for
  5. aiding in the consitency of user interface across discrete programs
  6. that need to provide a command line interface.
  7.  
  8.    Copyright (C) 1988, 1991 Free Software Foundation, Inc.
  9.  
  10.    Permission is granted to make and distribute verbatim copies of this
  11. manual provided the copyright notice and this permission notice pare
  12. preserved on all copies.
  13.  
  14.    Permission is granted to copy and distribute modified versions of
  15. this manual under the conditions for verbatim copying, provided that
  16. the entire resulting derived work is distributed under the terms of a
  17. permission notice identical to this one.
  18.  
  19.    Permission is granted to copy and distribute translations of this
  20. manual into another language, under the above conditions for modified
  21. versions, except that this permission notice may be stated in a
  22. translation approved by the Foundation.
  23.  
  25. File: readline.info,  Node: Top,  Next: Command Line Editing,  Prev: (DIR),  Up: (DIR)
  26.  
  27. GNU Readline Library
  28. ********************
  29.  
  30.    This document describes the GNU Readline Library, a utility for
  31. aiding in the consistency of user interface across discrete programs
  32. that need to provide a command line interface.
  33.  
  34. * Menu:
  35.  
  36. * Command Line Editing::       GNU Readline User's Manual.
  37. * Programming with GNU Readline::  GNU Readline Programmer's Manual.
  38. * Concept Index::           Index of concepts described in this manual.
  39. * Function and Variable Index::       Index of externally visible functions
  40.                    and variables.
  41.  
  43. File: readline.info,  Node: Command Line Editing,  Next: Programming with GNU Readline,  Prev: Top,  Up: Top
  44.  
  45. Command Line Editing
  46. ********************
  47.  
  48.    This text describes GNU's command line editing interface.
  49.  
  50. * Menu:
  51.  
  52. * Introduction and Notation::    Notation used in this text.
  53. * Readline Interaction::    The minimum set of commands for editing a line.
  54. * Readline Init File::        Customizing Readline from a user's view.
  55.  
  57. File: readline.info,  Node: Introduction and Notation,  Next: Readline Interaction,  Up: Command Line Editing
  58.  
  59. Introduction to Line Editing
  60. ============================
  61.  
  62.    In this tex a the following notation is used to describe keystrokes.
  63.  
  64.    The text C-k is read as `Control-K' and describes the character
  65. produced when the Control key is depressed and the k key is struck.
  66.  
  67.    The text M-k is read as `Meta-K' and describes the character
  68. produced when the meta key (if you have one) is depressed, and the k
  69. key is struck.  If you do not have a meta key, the identical keystroke
  70. can be generated by typing ESC first, and then typing k.  Either
  71. process is known as "metafying" the k key.
  72.  
  73.    The text M-C-k is read as `Meta-Control-k' and describes the
  74. character produced by "metafying" C-k.
  75.  
  76.    In addition, several keys have their own names.  Specifically, DEL,
  77. ESC, LFD, SPC, RET, and TAB all stand for themselves when seen in this
  78. text, or in an init file (*note Readline Init File::., for more info).
  79.  
  81. File: readline.info,  Node: Readline Interaction,  Next: Readline Init File,  Prev: Introduction and Notation,  Up: Command Line Editing
  82.  
  83. Readline Interaction
  84. ====================
  85.  
  86.    Often during an interactive session you type in a long line of text,
  87. only to notice that the first word on the line is misspelled.  The
  88. Readline library gives you a set of commands for manipulating the text
  89. as you type it in, allowing you to just fix your typo, and not forcing
  90. you to retype the majority of the line.  Using these editing commands,
  91. you move the cursor to the place that needs correction, and delete or
  92. insert the text of the corrections.  Then, when you are satisfied with
  93. the line, you simply press RETURN.  You do not have to be at the end of
  94. the line to press RETURN; the entire line is accepted regardless of the
  95. location of the cursor within the line.
  96.  
  97. * Menu:
  98.  
  99. * Readline Bare Essentials::    The least you need to know about Readline.
  100. * Readline Movement Commands::    Moving about the input line.
  101. * Readline Killing Commands::    How to delete text, and how to get it back!
  102. * Readline Arguments::        Giving numeric arguments to commands.
  103.  
  105. File: readline.info,  Node: Readline Bare Essentials,  Next: Readline Movement Commands,  Up: Readline Interaction
  106.  
  107. Readline Bare Essentials
  108. ------------------------
  109.  
  110.    In order to enter characters into the line, simply type them.  The
  111. typed character appears where the cursor was, and then the cursor moves
  112. one space to the right.  If you mistype a character, you can use DEL to
  113. back up, and delete the mistyped character.
  114.  
  115.    Sometimes you may miss typing a character that you wanted to type,
  116. and not notice your error until you have typed several other
  117. characters.  In that case, you can type C-b to move the cursor to the
  118. left, and then correct your mistake.  Aftwerwards, you can move the
  119. cursor to the right with C-f.
  120.  
  121.    When you add text in the middle of a line, you will notice that
  122. characters to the right of the cursor get `pushed over' to make room
  123. for the text that you have inserted.  Likewise, when you delete text
  124. behind the cursor, characters to the right of the cursor get `pulled
  125. back' to fill in the blank space created by the removal of the text.  A
  126. list of the basic bare essentials for editing the text of an input line
  127. follows.
  128.  
  129. C-b
  130.      Move back one character.
  131.  
  132. C-f
  133.      Move forward one character.
  134.  
  135. DEL
  136.      Delete the character to the left of the cursor.
  137.  
  138. C-d
  139.      Delete the character underneath the cursor.
  140.  
  141. Printing characters
  142.      Insert itself into the line at the cursor.
  143.  
  144. C-_
  145.      Undo the last thing that you did.  You can undo all the way back
  146.      to an empty line.
  147.  
  149. File: readline.info,  Node: Readline Movement Commands,  Next: Readline Killing Commands,  Prev: Readline Bare Essentials,  Up: Readline Interaction
  150.  
  151. Readline Movement Commands
  152. --------------------------
  153.  
  154.    The above table describes the most basic possible keystrokes that
  155. you need in order to do editing of the input line.  For your
  156. convenience, many other commands have been added in addition to C-b,
  157. C-f, C-d, and DEL.  Here are some commands for moving more rapidly
  158. about the line.
  159.  
  160. C-a
  161.      Move to the start of the line.
  162.  
  163. C-e
  164.      Move to the end of the line.
  165.  
  166. M-f
  167.      Move forward a word.
  168.  
  169. M-b
  170.      Move backward a word.
  171.  
  172. C-l
  173.      Clear the screen, reprinting the current line at the top.
  174.  
  175.    Notice how C-f moves forward a character, while M-f moves forward a
  176. word.  It is a loose convention that control keystrokes operate on
  177. characters while meta keystrokes operate on words.
  178.  
  180. File: readline.info,  Node: Readline Killing Commands,  Next: Readline Arguments,  Prev: Readline Movement Commands,  Up: Readline Interaction
  181.  
  182. Readline Killing Commands
  183. -------------------------
  184.  
  185.    The act of "cutting" text means to delete the text from the line, and
  186. to save away the deleted text for later use, just as if you had cut the
  187. text out of the line with a pair of scissors.  There is a
  188.  
  189.    "Killing" text means to delete the text from the line, but to save
  190. it away for later use, usually by "yanking" it back into the line.  If
  191. the description for a command says that it `kills' text, then you can
  192. be sure that you can get the text back in a different (or the same)
  193. place later.
  194.  
  195.    Here is the list of commands for killing text.
  196.  
  197. C-k
  198.      Kill the text from the current cursor position to the end of the
  199.      line.
  200.  
  201. M-d
  202.      Kill from the cursor to the end of the current word, or if between
  203.      words, to the end of the next word.
  204.  
  205. M-DEL
  206.      Kill fromthe cursor the start ofthe previous word, or if between
  207.      words, to the start of the previous word.
  208.  
  209. C-w
  210.      Kill from the cursor to the previous whitespace.  This is
  211.      different than M-DEL because the word boundaries differ.
  212.  
  213.    And, here is how to "yank" the text back into the line.  Yanking is
  214.  
  215. C-y
  216.      Yank the most recently killed text back into the buffer at the
  217.      cursor.
  218.  
  219. M-y
  220.      Rotate the kill-ring, and yank the new top.  You can only do this
  221.      if the prior command is C-y or M-y.
  222.  
  223.    When you use a kill command, the text is saved in a "kill-ring".
  224. Any number of consecutive kills save all of the killed text together, so
  225. that when you yank it back, you get it in one clean sweep.  The kill
  226. ring is not line specific; the text that you killed on a previously
  227. typed line is available to be yanked back later, when you are typing
  228. another line.
  229.  
  231. File: readline.info,  Node: Readline Arguments,  Prev: Readline Killing Commands,  Up: Readline Interaction
  232.  
  233. Readline Arguments
  234. ------------------
  235.  
  236.    You can pass numeric arguments to Readline commands.  Sometimes the
  237. argument acts as a repeat count, other times it is the sign of the
  238. argument that is significant.  If you pass a negative argument to a
  239. command which normally acts in a forward direction, that command will
  240. act in a backward direction.  For example, to kill text back to the
  241. start of the line, you might type M- C-k.
  242.  
  243.    The general way to pass numeric arguments to a command is to type
  244. meta digits before the command.  If the first `digit' you type is a
  245. minus sign (-), then the sign of the argument will be negative.  Once
  246. you have typed one meta digit to get the argument started, you can type
  247. the remainder of the digits, and then the command.  For example, to give
  248. the C-d command an argument of 10, you could type M-1 0 C-d.
  249.  
  251. File: readline.info,  Node: Readline Init File,  Prev: Readline Interaction,  Up: Command Line Editing
  252.  
  253. Readline Init File
  254. ==================
  255.  
  256.    Although the Readline library comes with a set of Emacs-like
  257. keybindings, it is possible that you would like to use a different set
  258. of keybindings.  You can customize programs that use Readline by putting
  259. commands in an "init" file in your home directory.  The name of this
  260. file is `~/.inputrc'.
  261.  
  262.    When a program which uses the Readline library starts up, the
  263. `~/.inputrc' file is read, and the keybindings are set.
  264.  
  265. * Menu:
  266.  
  267. * Readline Init Syntax::    Syntax for the commands in `~/.inputrc'.
  268. * Readline Vi Mode::        Switching to `vi' mode in Readline.
  269.  
  271. File: readline.info,  Node: Readline Init Syntax,  Next: Readline Vi Mode,  Up: Readline Init File
  272.  
  273. Readline Init Syntax
  274. --------------------
  275.  
  276.    You can start up with a vi-like editing mode by placing
  277.  
  278.      `set editing-mode vi'
  279.  
  280.    in your `~/.inputrc' file.
  281.  
  282.    You can have Readline use a single line for display, scrolling the
  283. input between the two edges of the screen by placing
  284.  
  285.      `set horizontal-scroll-mode On'
  286.  
  287.    in your `~/.inputrc' file.
  288.  
  289.    The syntax for controlling keybindings in the `~/.inputrc' file is
  290. simple.  First you have to know the name of the command that you want
  291. to change.  The following pages contain tables of the command name, the
  292. default keybinding, and a short description of what the command does.
  293.  
  294.    Once you know the name of the command, simply place the name of the
  295. key you wish to bind the command to, a colon, and then the name of the
  296. command on a line in the `~/.inputrc' file.  Here is an example:
  297.  
  298.      # This is a comment line.
  299.      Meta-Rubout:    backward-kill-word
  300.      Control-u:    universal-argument
  301.  
  302. * Menu:
  303.  
  304. * Commands For Moving::        Moving about the line.
  305. * Commands For History::    Getting at previous lines.
  306. * Commands For Text::        Commands for changing text.
  307. * Commands For Killing::    Commands for killing and yanking.
  308. * Numeric Arguments::        Specifying numeric arguments, repeat counts.
  309. * Commands For Completion::    Getting Readline to do the typing for you.
  310. * Miscellaneous Commands::    Other miscillaneous commands.
  311.  
  313. File: readline.info,  Node: Commands For Moving,  Next: Commands For History,  Up: Readline Init Syntax
  314.  
  315. Commands For Moving
  316. ...................
  317.  
  318. `beginning-of-line (C-a)'
  319.      Move to the start of the current line.
  320.  
  321. `end-of-line (C-e)'
  322.      Move to the end of the line.
  323.  
  324. `forward-char (C-f)'
  325.      Move forward a character.
  326.  
  327. `backward-char (C-b)'
  328.      Move back a character.
  329.  
  330. `forward-word (M-f)'
  331.      Move forward to the end of the next word.
  332.  
  333. `backward-word (M-b)'
  334.      Move back to the start of this, or the previous, word.
  335.  
  336. `clear-screen (C-l)'
  337.      Clear the screen leaving the current line at the top of the screen.
  338.  
  340. File: readline.info,  Node: Commands For History,  Next: Commands For Text,  Prev: Commands For Moving,  Up: Readline Init Syntax
  341.  
  342. Commands For Manipulating The History
  343. .....................................
  344.  
  345. `accept-line (Newline, Return)'
  346.      Accept the line regardless of where the cursor is.  If this line is
  347.      non-empty, add it too the history list.  If this line was a history
  348.      line, then restore the history line to its original state.
  349.  
  350. `previous-history (C-p)'
  351.      Move `up' through the history list.
  352.  
  353. `next-history (C-n)'
  354.      Move `down' through the history list.
  355.  
  356. `beginning-of-history (M-<)'
  357.      Move to the first line in the history.
  358.  
  359. `end-of-history (M->)'
  360.      Move to the end of the input history, i.e., the line you are
  361.      entering!
  362.  
  363. `reverse-search-history (C-r)'
  364.      Search backward starting at the current line and moving `up'
  365.      through the history as necessary.  This is an incremental search.
  366.  
  367. `forward-search-history (C-s)'
  368.      Search forward starting at the current line and moving `down'
  369.      through the the history as neccessary.
  370.  
  372. File: readline.info,  Node: Commands For Text,  Next: Commands For Killing,  Prev: Commands For History,  Up: Readline Init Syntax
  373.  
  374. Commands For Changing Text
  375. ..........................
  376.  
  377. `delete-char (C-d)'
  378.      Delete the character under the cursor.  If the cursor is at the
  379.      beginning of the line, and there are no characters in the line, and
  380.      the last character typed was not C-d, then return EOF.
  381.  
  382. `backward-delete-char (Rubout)'
  383.      Delete the character behind the cursor.  A numeric arg says to kill
  384.      the characters instead of deleting them.
  385.  
  386. `quoted-insert (C-q, C-v)'
  387.      Add the next character that you type to the line verbatim.  This is
  388.      how to insert things like C-q for example.
  389.  
  390. `tab-insert (M-TAB)'
  391.      Insert a tab character.
  392.  
  393. `self-insert (a, b, A, 1, !, ...)'
  394.      Insert yourself.
  395.  
  396. `transpose-chars (C-t)'
  397.      Drag the character before point forward over the character at
  398.      point.  Point moves forward as well.  If point is at the end of
  399.      the line, then transpose the two characters before point.
  400.      Negative args don't work.
  401.  
  402. `transpose-words (M-t)'
  403.      Drag the word behind the cursor past the word in front of the
  404.      cursor moving the cursor over that word as well.
  405.  
  406. `upcase-word (M-u)'
  407.      Uppercase the current (or following) word.  With a negative
  408.      argument, do the previous word, but do not move point.
  409.  
  410. `downcase-word (M-l)'
  411.      Lowercase the current (or following) word.  With a negative
  412.      argument, do the previous word, but do not move point.
  413.  
  414. `capitalize-word (M-c)'
  415.      Uppercase the current (or following) word.  With a negative
  416.      argument, do the previous word, but do not move point.
  417.  
  419. File: readline.info,  Node: Commands For Killing,  Next: Numeric Arguments,  Prev: Commands For Text,  Up: Readline Init Syntax
  420.  
  421. Killing And Yanking
  422. ...................
  423.  
  424. `kill-line (C-k)'
  425.      Kill the text from the current cursor position to the end of the
  426.      line.
  427.  
  428. `backward-kill-line ()'
  429.      Kill backward to the beginning of the line.  This is normally
  430.      unbound.
  431.  
  432. `kill-word (M-d)'
  433.      Kill from the cursor to the end of the current word, or if between
  434.      words, to the end of the next word.
  435.  
  436. `backward-kill-word (M-DEL)'
  437.      Kill the word behind the cursor.
  438.  
  439. `unix-line-discard (C-u)'
  440.      Do what C-u used to do in Unix line input.  We save the killed
  441.      text on the kill-ring, though.
  442.  
  443. `unix-word-rubout (C-w)'
  444.      Do what C-w used to do in Unix line input.  The killed text is
  445.      saved on the kill-ring.  This is different than backward-kill-word
  446.      because the word boundaries differ.
  447.  
  448. `yank (C-y)'
  449.      Yank the top of the kill ring into the buffer at point.
  450.  
  451. `yank-pop (M-y)'
  452.      Rotate the kill-ring, and yank the new top.  You can only do this
  453.      if the prior command is yank or yank-pop.
  454.  
  456. File: readline.info,  Node: Numeric Arguments,  Next: Commands For Completion,  Prev: Commands For Killing,  Up: Readline Init Syntax
  457.  
  458. Specifying Numeric Arguments
  459. ............................
  460.  
  461. `digit-argument (M-0, M-1, ... M--)'
  462.      Add this digit to the argument already accumulating, or start a new
  463.      argument.  M- starts a negative argument.
  464.  
  465. `universal-argument ()'
  466.      Do what C-u does in emacs.  By default, this is not bound.
  467.  
  469. File: readline.info,  Node: Commands For Completion,  Next: Miscellaneous Commands,  Prev: Numeric Arguments,  Up: Readline Init Syntax
  470.  
  471. Letting Readline Type For You
  472. .............................
  473.  
  474. `complete (TAB)'
  475.      Attempt to do completion on the text before point.  This is
  476.      implementation defined.  Generally, if you are typing a filename
  477.      argument, you can do filename completion; if you are typing a
  478.      command, you can do command completion, if you are typing in a
  479.      symbol to GDB, you can do symbol name completion, if you are
  480.      typing in a variable to Bash, you can do variable name
  481.      completion...
  482.  
  483. `possible-completions (M-?)'
  484.      List the possible completions of the text before point.
  485.  
  487. File: readline.info,  Node: Miscellaneous Commands,  Prev: Commands For Completion,  Up: Readline Init Syntax
  488.  
  489. Some Miscellaneous Commands
  490. ...........................
  491.  
  492. `abort (C-g)'
  493.      Ding!  Stops things.
  494.  
  495. `do-uppercase-version (M-a, M-b, ...)'
  496.      Run the command that is bound to your uppercase brother.
  497.  
  498. `prefix-meta (ESC)'
  499.      Make the next character that you type be metafied.  This is for
  500.      people without a meta key.  ESC-f is equivalent to M-f.
  501.  
  502. `undo (C-_)'
  503.      Incremental undo, separately remembered for each line.
  504.  
  505. `revert-line (M-r)'
  506.      Undo all changes made to this line.  This is like typing the `undo'
  507.      command enough times to get back to the beginning.
  508.  
  510. File: readline.info,  Node: Readline Vi Mode,  Prev: Readline Init Syntax,  Up: Readline Init File
  511.  
  512. Readline Vi Mode
  513. ----------------
  514.  
  515.    While the Readline library does not have a full set of Vi editing
  516. functions, it does contain enough to allow simple editing of the line.
  517.  
  518.    In order to switch interactively between Emacs and Vi editing modes,
  519. use the command M-C-j (toggle-editing-mode).
  520.  
  521.    When you enter a line in Vi mode, you are already placed in
  522. `insertion' mode, as if you had typed an `i'.  Pressing ESC switches
  523. you into `edit' mode, where you can edit the text of the line with the
  524. standard Vi movement keys, move to previous history lines with `k', and
  525. following lines with `j', and so forth.
  526.  
  527.    This document describes the GNU Readline Library, a utility for
  528. aiding in the consitency of user interface across discrete programs
  529. that need to provide a command line interface.
  530.  
  531.    Copyright (C) 1988 Free Software Foundation, Inc.
  532.  
  533.    Permission is granted to make and distribute verbatim copies of this
  534. manual provided the copyright notice and this permission notice pare
  535. preserved on all copies.
  536.  
  537.    Permission is granted to copy and distribute modified versions of
  538. this manual under the conditions for verbatim copying, provided that
  539. the entire resulting derived work is distributed under the terms of a
  540. permission notice identical to this one.
  541.  
  542.    Permission is granted to copy and distribute translations of this
  543. manual into another language, under the above conditions for modified
  544. versions, except that this permission notice may be stated in a
  545. translation approved by the Foundation.
  546.  
  548. File: readline.info,  Node: Programming with GNU Readline,  Next: Concept Index,  Prev: Command Line Editing,  Up: Top
  549.  
  550. Programming with GNU Readline
  551. *****************************
  552.  
  553.    This manual describes the interface between the GNU Readline Library
  554. and user programs.  If you are a programmer, and you wish to include the
  555. features found in GNU Readline in your own programs, such as completion,
  556. line editing, and interactive history manipulation, this documentation
  557. is for you.
  558.  
  559. * Menu:
  560.  
  561. * Default Behaviour::    Using the default behaviour of Readline.
  562. * Custom Functions::    Adding your own functions to Readline.
  563. * Custom Completers::    Supplanting or supplementing Readline's
  564.             completion functions.
  565.  
  567. File: readline.info,  Node: Default Behaviour,  Next: Custom Functions,  Up: Programming with GNU Readline
  568.  
  569. Default Behaviour
  570. =================
  571.  
  572.    Many programs provide a command line interface, such as `mail',
  573. `ftp', and `sh'.  For such programs, the default behaviour of Readline
  574. is sufficient.  This section describes how to use Readline in the
  575. simplest way possible, perhaps to replace calls in your code to `gets
  576. ()'.
  577.  
  578.    The function `readline' prints a prompt and then reads and returns a
  579. single line of text from the user.  The line which `readline ()'
  580. returns is allocated with `malloc ()'; you should `free ()' the line
  581. when you are done with it.  The declaration for `readline' in ANSI C is
  582.  
  583.      `char *readline (char *PROMPT);'
  584.  
  585.    So, one might say
  586.      `char *line = readline ("Enter a line: ");'
  587.    in order to read a line of text from the user.
  588.  
  589.    The line which is returned has the final newline removed, so only the
  590. text of the line remains.
  591.  
  592.    If readline encounters an `EOF' while reading the line, and the line
  593. is empty at that point, then `(char *)NULL' is returned.  Otherwise,
  594. the line is ended just as if a newline was typed.
  595.  
  596.    If you want the user to be able to get at the line later, (with C-p
  597. for example), you must call `add_history ()' to save the line away in a
  598. "history" list of such lines.
  599.  
  600.      `add_history (line)';
  601.  
  602.    For full details on the GNU History Library, see the associated
  603. manual.
  604.  
  605.    It is polite to avoid saving empty lines on the history list, since
  606. it is rare than someone has a burning need to reuse a blank line.  Here
  607. is a function which usefully replaces the standard `gets ()' library
  608. function:
  609.  
  610.      /* A static variable for holding the line. */
  611.      static char *line_read = (char *)NULL;
  612.      
  613.      /* Read a string, and return a pointer to it.  Returns NULL on EOF. */
  614.      char *
  615.      do_gets ()
  616.      {
  617.        /* If the buffer has already been allocated, return the memory
  618.           to the free pool. */
  619.        if (line_read != (char *)NULL)
  620.          {
  621.            free (line_read);
  622.            line_read = (char *)NULL;
  623.          }
  624.      
  625.        /* Get a line from the user. */
  626.        line_read = readline ("");
  627.      
  628.        /* If the line has any text in it, save it on the history. */
  629.        if (line_read && *line_read)
  630.          add_history (line_read);
  631.      
  632.        return (line_read);
  633.      }
  634.  
  635.    The above code gives the user the default behaviour of TAB
  636. completion: completion on file names.  If you do not want readline to
  637. complete on filenames, you can change the binding of the TAB key with
  638. `rl_bind_key ()'.
  639.  
  640.      `int rl_bind_key (int KEY, (int (*)())FUNCTION);'
  641.  
  642.    `rl_bind_key ()' takes 2 arguments; KEY is the character that you
  643. want to bind, and FUNCTION is the address of the function to run when
  644. KEY is pressed.  Binding TAB to `rl_insert ()' makes TAB just insert
  645. itself.
  646.  
  647.    `rl_bind_key ()' returns non-zero if KEY is not a valid ASCII
  648. character code (between 0 and 255).
  649.  
  650.      `rl_bind_key ('\t', rl_insert);'
  651.  
  652.    This code should be executed once at the start of your program; you
  653. might write a function called `initialize_readline ()' which performs
  654. this and other desired initializations, such as installing custom
  655. completers, etc.
  656.  
  658. File: readline.info,  Node: Custom Functions,  Next: Custom Completers,  Prev: Default Behaviour,  Up: Programming with GNU Readline
  659.  
  660. Custom Functions
  661. ================
  662.  
  663.    Readline provides a great many functions for manipulating the text of
  664. the line.  But it isn't possible to anticipate the needs of all
  665. programs.  This section describes the various functions and variables
  666. defined in within the Readline library which allow a user program to add
  667. customized functionality to Readline.
  668.  
  669. * Menu:
  670.  
  671. * The Function Type::    C declarations to make code readable.
  672. * Function Naming::    How to give a function you write a name.
  673. * Keymaps::        Making keymaps.
  674. * Binding Keys::    Changing Keymaps.
  675. * Function Writing::    Variables and calling conventions.
  676. * Allowing Undoing::    How to make your functions undoable.
  677.  
  679. File: readline.info,  Node: The Function Type,  Next: Function Naming,  Up: Custom Functions
  680.  
  681. The Function Type
  682. -----------------
  683.  
  684.    For the sake of readabilty, we declare a new type of object, called
  685. "Function".  A `Function' is a C language function which returns an
  686. `int'.  The type declaration for `Function' is:
  687.  
  688. `typedef int Function ();'
  689.  
  690.    The reason for declaring this new type is to make it easier to write
  691. code describing pointers to C functions.  Let us say we had a variable
  692. called FUNC which was a pointer to a function.  Instead of the classic
  693. C declaration
  694.  
  695.    `int (*)()func;'
  696.  
  697.    we have
  698.  
  699.    `Function *func;'
  700.  
  702. File: readline.info,  Node: Function Naming,  Next: Keymaps,  Prev: The Function Type,  Up: Custom Functions
  703.  
  704. Naming a Function
  705. -----------------
  706.  
  707.    The user can dynamically change the bindings of keys while using
  708. Readline.  This is done by representing the function with a descriptive
  709. name.  The user is able to type the descriptive name when referring to
  710. the function.  Thus, in an init file, one might find
  711.  
  712.      Meta-Rubout:    backward-kill-word
  713.  
  714.    This binds the keystroke Meta-Rubout to the function *descriptively*
  715. named `backward-kill-word'.  You, as the programmer, should bind the
  716. functions you write to descriptive names as well.  Readline provides a
  717. function for doing that:
  718.  
  719.  - Function: rl_add_defun (CHAR *NAME, FUNCTION *FUNCTION, INT KEY)
  720.      Add NAME to the list of named functions.  Make FUNCTION be the
  721.      function that gets called.  If KEY is not -1, then bind it to
  722.      FUNCTION using `rl_bind_key ()'.
  723.  
  724.    Using this function alone is sufficient for most applications.  It is
  725. the recommended way to add a few functions to the default functions that
  726. Readline has built in already.  If you need to do more or different
  727. things than adding a function to Readline, you may need to use the
  728. underlying functions described below.
  729.  
  731. File: readline.info,  Node: Keymaps,  Next: Binding Keys,  Prev: Function Naming,  Up: Custom Functions
  732.  
  733. Selecting a Keymap
  734. ------------------
  735.  
  736.    Key bindings take place on a "keymap".  The keymap is the
  737. association between the keys that the user types and the functions that
  738. get run.  You can make your own keymaps, copy existing keymaps, and tell
  739. Readline which keymap to use.
  740.  
  741.  - Function: Keymap rl_make_bare_keymap ()
  742.      Returns a new, empty keymap.  The space for the keymap is
  743.      allocated with `malloc ()'; you should `free ()' it when you are
  744.      done.
  745.  
  746.  - Function: Keymap rl_copy_keymap (KEYMAP MAP)
  747.      Return a new keymap which is a copy of MAP.
  748.  
  749.  - Function: Keymap rl_make_keymap ()
  750.      Return a new keymap with the printing characters bound to
  751.      rl_insert, the lowercase Meta characters bound to run their
  752.      equivalents, and the Meta digits bound to produce numeric
  753.      arguments.
  754.  
  756. File: readline.info,  Node: Binding Keys,  Next: Function Writing,  Prev: Keymaps,  Up: Custom Functions
  757.  
  758. Binding Keys
  759. ------------
  760.  
  761.    You associate keys with functions through the keymap.  Here are
  762. functions for doing that.
  763.  
  764.  - Function: int rl_bind_key (INT KEY, FUNCTION *FUNCTION)
  765.      Binds KEY to FUNCTION in the currently selected keymap.  Returns
  766.      non-zero in the case of an invalid KEY.
  767.  
  768.  - Function: int rl_bind_key_in_map (INT KEY, FUNCTION *FUNCTION,
  769.           KEYMAP MAP)
  770.      Bind KEY to FUNCTION in MAP.  Returns non-zero in the case of an
  771.      invalid KEY.
  772.  
  773.  - Function: int rl_unbind_key (INT KEY)
  774.      Make KEY do nothing in the currently selected keymap.  Returns
  775.      non-zero in case of error.
  776.  
  777.  - Function: int rl_unbind_key_in_map (INT KEY, KEYMAP MAP)
  778.      Make KEY be bound to the null function in MAP.  Returns non-zero
  779.      in case of error.
  780.  
  781.  - Function: rl_generic_bind (INT TYPE, CHAR *KEYSEQ, CHAR *DATA,
  782.           KEYMAP MAP)
  783.      Bind the key sequence represented by the string KEYSEQ to the
  784.      arbitrary pointer DATA.  TYPE says what kind of data is pointed to
  785.      by DATA; right now this can be a function (`ISFUNC'), a macro
  786.      (`ISMACR'), or a keymap (`ISKMAP').  This makes new keymaps as
  787.      necessary.  The initial place to do bindings is in MAP.
  788.  
  790. File: readline.info,  Node: Function Writing,  Next: Allowing Undoing,  Prev: Binding Keys,  Up: Custom Functions
  791.  
  792. Writing a New Function
  793. ----------------------
  794.  
  795.    In order to write new functions for Readline, you need to know the
  796. calling conventions for keyboard invoked functions, and the names of the
  797. variables that describe the current state of the line gathered so far.
  798.  
  799.  - Variable: char *rl_line_buffer
  800.      This is the line gathered so far.  You are welcome to modify the
  801.      contents of this, but see Undoing, below.
  802.  
  803.  - Variable: int rl_point
  804.      The offset of the current cursor position in RL_LINE_BUFFER.
  805.  
  806.  - Variable: int rl_end
  807.      The number of characters present in `rl_line_buffer'.  When
  808.      `rl_point' is at the end of the line, then `rl_point' and `rl_end'
  809.      are equal.
  810.  
  811.    The calling sequence for a command `foo' looks like
  812.  
  813.      `foo (int count, int key)'
  814.  
  815.    where COUNT is the numeric argument (or 1 if defaulted) and KEY is
  816. the key that invoked this function.
  817.  
  818.    It is completely up to the function as to what should be done with
  819. the numeric argument; some functions use it as a repeat count, other
  820. functions as a flag, and some choose to ignore it.  In general, if a
  821. function uses the numeric argument as a repeat count, it should be able
  822. to do something useful with a negative argument as well as a positive
  823. argument.  At the very least, it should be aware that it can be passed a
  824. negative argument.
  825.  
  827. File: readline.info,  Node: Allowing Undoing,  Prev: Function Writing,  Up: Custom Functions
  828.  
  829. Allowing Undoing
  830. ----------------
  831.  
  832.    Supporting the undo command is a painless thing to do, and makes your
  833. functions much more useful to the end user.  It is certainly easy to try
  834. something if you know you can undo it.  I could use an undo function for
  835. the stock market.
  836.  
  837.    If your function simply inserts text once, or deletes text once, and
  838. it calls `rl_insert_text ()' or `rl_delete_text ()' to do it, then
  839. undoing is already done for you automatically, and you can safely skip
  840. this section.
  841.  
  842.    If you do multiple insertions or multiple deletions, or any
  843. combination of these operations, you should group them together into
  844. one operation.  This can be done with `rl_begin_undo_group ()' and
  845. `rl_end_undo_group ()'.
  846.  
  847.  - Function: rl_begin_undo_group ()
  848.      Begins saving undo information in a group construct.  The undo
  849.      information usually comes from calls to `rl_insert_text ()' and
  850.      `rl_delete_text ()', but they could be direct calls to
  851.      `rl_add_undo ()'.
  852.  
  853.  - Function: rl_end_undo_group ()
  854.      Closes the current undo group started with `rl_begin_undo_group
  855.      ()'.  There should be exactly one call to `rl_end_undo_group ()'
  856.      for every call to `rl_begin_undo_group ()'.
  857.  
  858.    Finally, if you neither insert nor delete text, but directly modify
  859. the existing text (e.g. change its case), you call `rl_modifying ()'
  860. once, just before you modify the text.  You must supply the indices of
  861. the text range that you are going to modify.
  862.  
  863.  - Function: rl_modifying (INT START, INT END)
  864.      Tell Readline to save the text between START and END as a single
  865.      undo unit.  It is assumed that subsequent to this call you will
  866.      modify that range of text in some way.
  867.  
  868. An Example
  869. ----------
  870.  
  871.    Here is a function which changes lowercase characters to the
  872. uppercase equivalents, and uppercase characters to the lowercase
  873. equivalents.  If this function was bound to `M-c', then typing `M-c'
  874. would change the case of the character under point.  Typing `10 M-c'
  875. would change the case of the following 10 characters, leaving the
  876. cursor on the last character changed.
  877.  
  878.      /* Invert the case of the COUNT following characters. */
  879.      invert_case_line (count, key)
  880.           int count, key;
  881.      {
  882.        register int start, end;
  883.      
  884.        start = rl_point;
  885.      
  886.        if (count < 0)
  887.          {
  888.            direction = -1;
  889.            count = -count;
  890.          }
  891.        else
  892.          direction = 1;
  893.      
  894.        /* Find the end of the range to modify. */
  895.        end = start + (count * direction);
  896.      
  897.        /* Force it to be within range. */
  898.        if (end > rl_end)
  899.          end = rl_end;
  900.        else if (end < 0)
  901.          end = -1;
  902.      
  903.        if (start > end)
  904.          {
  905.            int temp = start;
  906.            start = end;
  907.            end = temp;
  908.          }
  909.      
  910.        if (start == end)
  911.          return;
  912.      
  913.        /* Tell readline that we are modifying the line, so save the undo
  914.           information. */
  915.        rl_modifying (start, end);
  916.      
  917.        for (; start != end; start += direction)
  918.          {
  919.            if (uppercase_p (rl_line_buffer[start]))
  920.              rl_line_buffer[start] = to_lower (rl_line_buffer[start]);
  921.            else if (lowercase_p (rl_line_buffer[start]))
  922.              rl_line_buffer[start] = to_upper (rl_line_buffer[start]);
  923.          }
  924.        /* Move point to on top of the last character changed. */
  925.        rl_point = end - direction;
  926.      }
  927.  
  929. File: readline.info,  Node: Custom Completers,  Prev: Custom Functions,  Up: Programming with GNU Readline
  930.  
  931. Custom Completers
  932. =================
  933.  
  934.    Typically, a program that reads commands from the user has a way of
  935. disambiguating between commands and data.  If your program is one of
  936. these, then it can provide completion for either commands, or data, or
  937. both commands and data.  The following sections describe how your
  938. program and Readline cooperate to provide this service to end users.
  939.  
  940. * Menu:
  941.  
  942. * How Completing Works::    The logic used to do completion.
  943. * Completion Functions::    Functions provided by Readline.
  944. * Completion Variables::    Variables which control completion.
  945. * A Short Completion Example::    An example of writing completer subroutines.
  946.  
  948. File: readline.info,  Node: How Completing Works,  Next: Completion Functions,  Up: Custom Completers
  949.  
  950. How Completing Works
  951. --------------------
  952.  
  953.    In order to complete some text, the full list of possible completions
  954. must be available.  That is to say, it is not possible to accurately
  955. expand a partial word without knowing what all of the possible words
  956. that make sense in that context are.  The GNU Readline library provides
  957. the user interface to completion, and additionally, two of the most
  958. common completion functions; filename and username.  For completing
  959. other types of text, you must write your own completion function.  This
  960. section describes exactly what those functions must do, and provides an
  961. example function.
  962.  
  963.    There are three major functions used to perform completion:
  964.  
  965.   1. The user-interface function `rl_complete ()'.  This function is
  966.      called interactively with the same calling conventions as other
  967.      functions in readline intended for interactive use; i.e. COUNT,
  968.      and `invoking-key'.  It isolates the word to be completed and calls
  969.      `completion_matches ()' to generate a list of possible completions.
  970.      It then either lists the possible completions or actually performs
  971.      the completion, depending on which behaviour is desired.
  972.  
  973.   2. The internal function `completion_matches ()' uses your
  974.      "generator" function to generate the list of possible matches, and
  975.      then returns the array of these matches.  You should place the
  976.      address of your generator function in
  977.      `rl_completion_entry_function'.
  978.  
  979.   3. The generator function is called repeatedly from
  980.      `completion_matches ()', returning a string each time.  The
  981.      arguments to the generator function are TEXT and STATE.  TEXT is
  982.      the partial word to be completed.  STATE is zero the first time
  983.      the function is called, and a positive non-zero integer for each
  984.      subsequent call.  When the generator function returns `(char
  985.      *)NULL' this signals `completion_matches ()' that there are no more
  986.      possibilities left.
  987.  
  988.  
  989.  - Function: rl_complete (INT IGNORE, INT INVOKING_KEY)
  990.      Complete the word at or before point.  You have supplied the
  991.      function that does the initial simple matching selection algorithm
  992.      (see `completion_matches ()').  The default is to do filename
  993.      completion.
  994.  
  995.    Note that `rl_complete ()' has the identical calling conventions as
  996. any other key-invokable function; this is because by default it is bound
  997. to the `TAB' key.
  998.  
  999.  - Variable: Function *rl_completion_entry_function
  1000.      This is a pointer to the generator function for `completion_matches
  1001.      ()'.  If the value of `rl_completion_entry_function' is `(Function
  1002.      *)NULL' then the default filename generator function is used,
  1003.      namely `filename_entry_function ()'.
  1004.  
  1006. File: readline.info,  Node: Completion Functions,  Next: Completion Variables,  Prev: How Completing Works,  Up: Custom Completers
  1007.  
  1008. Completion Functions
  1009. --------------------
  1010.  
  1011.    Here is the complete list of callable completion functions present in
  1012. Readline.
  1013.  
  1014.  - Function: rl_complete_internal (INT WHAT_TO_DO)
  1015.      Complete the word at or before point.  WHAT_TO_DO says what to do
  1016.      with the completion.  A value of `?' means list the possible
  1017.      completions.  `TAB' means do standard completion.  `*' means
  1018.      insert all of the possible completions.
  1019.  
  1020.  - Function: rl_complete (INT IGNORE, INT INVOKING_KEY)
  1021.      Complete the word at or before point.  You have supplied the
  1022.      function that does the initial simple matching selection algorithm
  1023.      (see `completion_matches ()').  The default is to do filename
  1024.      completion.  This just calls `rl_complete_internal ()' with an
  1025.      argument of `TAB'.
  1026.  
  1027.  - Function: rl_possible_completions ()
  1028.      List the possible completions.  See description of `rl_complete
  1029.      ()'.  This just calls `rl_complete_internal ()' with an argument of
  1030.      `?'.
  1031.  
  1032.  - Function: char **completion_matches (CHAR *TEXT, CHAR
  1033.           *(*ENTRY_FUNCTION) ())
  1034.      Returns an array of `(char *)' which is a list of completions for
  1035.      TEXT.  If there are no completions, returns `(char **)NULL'.  The
  1036.      first entry in the returned array is the substitution for TEXT.
  1037.      The remaining entries are the possible completions.  The array is
  1038.      terminated with a `NULL' pointer.
  1039.  
  1040.      ENTRY_FUNCTION is a function of two args, and returns a `(char
  1041.      *)'.  The first argument is TEXT.  The second is a state argument;
  1042.      it is zero on the first call, and non-zero on subsequent calls.
  1043.      It returns a `NULL'  pointer to the caller when there are no more
  1044.      matches.
  1045.  
  1046.  - Function: char *filename_completion_function (CHAR *TEXT, INT STATE)
  1047.      A generator function for filename completion in the general case.
  1048.      Note that completion in the Bash shell is a little different
  1049.      because of all the pathnames that must be followed when looking up
  1050.      the completion for a command.
  1051.  
  1052.  - Function: char *username_completion_function (CHAR *TEXT, INT STATE)
  1053.      A completion generator for usernames.  TEXT contains a partial
  1054.      username preceded by a random character (usually `~').
  1055.  
  1057. File: readline.info,  Node: Completion Variables,  Next: A Short Completion Example,  Prev: Completion Functions,  Up: Custom Completers
  1058.  
  1059. Completion Variables
  1060. --------------------
  1061.  
  1062.  - Variable: Function *rl_completion_entry_function
  1063.      A pointer to the generator function for `completion_matches ()'.
  1064.      `NULL' means to use `filename_entry_function ()', the default
  1065.      filename completer.
  1066.  
  1067.  - Variable: Function *rl_attempted_completion_function
  1068.      A pointer to an alternative function to create matches.  The
  1069.      function is called with TEXT, START, and END.  START and END are
  1070.      indices in `rl_line_buffer' saying what the boundaries of TEXT
  1071.      are.  If this function exists and returns `NULL' then `rl_complete
  1072.      ()' will call the value of `rl_completion_entry_function' to
  1073.      generate matches, otherwise the array of strings returned will be
  1074.      used.
  1075.  
  1076.  - Variable: int rl_completion_query_items
  1077.      Up to this many items will be displayed in response to a
  1078.      possible-completions call.  After that, we ask the user if she is
  1079.      sure she wants to see them all.  The default value is 100.
  1080.  
  1081.  - Variable: char *rl_basic_word_break_characters
  1082.      The basic list of characters that signal a break between words for
  1083.      the completer routine.  The contents of this variable is what
  1084.      breaks words in the Bash shell, i.e. " \t\n\"\\'`@$><=".
  1085.  
  1086.  - Variable: char *rl_completer_word_break_characters
  1087.      The list of characters that signal a break between words for
  1088.      `rl_complete_internal ()'.  The default list is the contents of
  1089.      `rl_basic_word_break_characters'.
  1090.  
  1091.  - Variable: char *rl_special_prefixes
  1092.      The list of characters that are word break characters, but should
  1093.      be left in TEXT when it is passed to the completion function.
  1094.      Programs can use this to help determine what kind of completing to
  1095.      do.
  1096.  
  1097.  - Variable: int rl_ignore_completion_duplicates
  1098.      If non-zero, then disallow duplicates in the matches.  Default is
  1099.      1.
  1100.  
  1101.  - Variable: int rl_filename_completion_desired
  1102.      Non-zero means that the results of the matches are to be treated as
  1103.      filenames.  This is *always* zero on entry, and can only be changed
  1104.      within a completion entry generator function.
  1105.  
  1106.  - Variable: Function *rl_ignore_some_completions_function
  1107.      This function, if defined, is called by the completer when real
  1108.      filename completion is done, after all the matching names have
  1109.      been generated.  It is passed a `NULL' terminated array of
  1110.      pointers to `(char *)' known as MATCHES in the code.  The 1st
  1111.      element (`matches[0]') is the maximal substring that is common to
  1112.      all matches. This function can re-arrange the list of matches as
  1113.      required, but each deleted element of the array must be `free()''d.
  1114.  
  1116. File: readline.info,  Node: A Short Completion Example,  Prev: Completion Variables,  Up: Custom Completers
  1117.  
  1118. A Short Completion Example
  1119. --------------------------
  1120.  
  1121.    Here is a small application demonstrating the use of the GNU Readline
  1122. library.  It is called `fileman', and the source code resides in
  1123. `readline/examples/fileman.c'.  This sample application provides
  1124. completion of command names, line editing features, and access to the
  1125. history list.
  1126.  
  1127.      /* fileman.c -- A tiny application which demonstrates how to use the
  1128.         GNU Readline library.  This application interactively allows users
  1129.         to manipulate files and their modes. */
  1130.      
  1131.      #include <stdio.h>
  1132.      #include <readline/readline.h>
  1133.      #include <readline/history.h>
  1134.      #include <sys/types.h>
  1135.      #include <sys/file.h>
  1136.      #include <sys/stat.h>
  1137.      #include <sys/errno.h>
  1138.      
  1139.      /* The names of functions that actually do the manipulation. */
  1140.      int com_list (), com_view (), com_rename (), com_stat (), com_pwd ();
  1141.      int com_delete (), com_help (), com_cd (), com_quit ();
  1142.      
  1143.      /* A structure which contains information on the commands this program
  1144.         can understand. */
  1145.      
  1146.      typedef struct {
  1147.        char *name;                   /* User printable name of the function. */
  1148.        Function *func;               /* Function to call to do the job. */
  1149.        char *doc;                    /* Documentation for this function.  */
  1150.      } COMMAND;
  1151.      
  1152.      COMMAND commands[] = {
  1153.        { "cd", com_cd, "Change to directory DIR" },
  1154.        { "delete", com_delete, "Delete FILE" },
  1155.        { "help", com_help, "Display this text" },
  1156.        { "?", com_help, "Synonym for `help'" },
  1157.        { "list", com_list, "List files in DIR" },
  1158.        { "ls", com_list, "Synonym for `list'" },
  1159.        { "pwd", com_pwd, "Print the current working directory" },
  1160.        { "quit", com_quit, "Quit using Fileman" },
  1161.        { "rename", com_rename, "Rename FILE to NEWNAME" },
  1162.        { "stat", com_stat, "Print out statistics on FILE" },
  1163.        { "view", com_view, "View the contents of FILE" },
  1164.        { (char *)NULL, (Function *)NULL, (char *)NULL }
  1165.      };
  1166.      
  1167.      /* The name of this program, as taken from argv[0]. */
  1168.      char *progname;
  1169.      
  1170.      /* When non-zero, this global means the user is done using this program. */
  1171.      int done = 0;
  1172.      
  1173.      main (argc, argv)
  1174.           int argc;
  1175.           char **argv;
  1176.      {
  1177.        progname = argv[0];
  1178.      
  1179.        initialize_readline ();       /* Bind our completer. */
  1180.      
  1181.        /* Loop reading and executing lines until the user quits. */
  1182.        while (!done)
  1183.          {
  1184.            char *line;
  1185.      
  1186.            line = readline ("FileMan: ");
  1187.      
  1188.            if (!line)
  1189.              {
  1190.                done = 1;             /* Encountered EOF at top level. */
  1191.              }
  1192.            else
  1193.              {
  1194.                /* Remove leading and trailing whitespace from the line.
  1195.                   Then, if there is anything left, add it to the history list
  1196.                   and execute it. */
  1197.                stripwhite (line);
  1198.      
  1199.                if (*line)
  1200.                  {
  1201.                    add_history (line);
  1202.                    execute_line (line);
  1203.                  }
  1204.              }
  1205.      
  1206.            if (line)
  1207.              free (line);
  1208.          }
  1209.        exit (0);
  1210.      }
  1211.      
  1212.      /* Execute a command line. */
  1213.      execute_line (line)
  1214.           char *line;
  1215.      {
  1216.        register int i;
  1217.        COMMAND *find_command (), *command;
  1218.        char *word;
  1219.      
  1220.        /* Isolate the command word. */
  1221.        i = 0;
  1222.        while (line[i] && !whitespace (line[i]))
  1223.          i++;
  1224.      
  1225.        word = line;
  1226.      
  1227.        if (line[i])
  1228.          line[i++] = '\0';
  1229.      
  1230.        command = find_command (word);
  1231.      
  1232.        if (!command)
  1233.          {
  1234.            fprintf (stderr, "%s: No such command for FileMan.\n", word);
  1235.            return;
  1236.          }
  1237.      
  1238.        /* Get argument to command, if any. */
  1239.        while (whitespace (line[i]))
  1240.          i++;
  1241.      
  1242.        word = line + i;
  1243.      
  1244.        /* Call the function. */
  1245.        (*(command->func)) (word);
  1246.      }
  1247.      
  1248.      /* Look up NAME as the name of a command, and return a pointer to that
  1249.         command.  Return a NULL pointer if NAME isn't a command name. */
  1250.      COMMAND *
  1251.      find_command (name)
  1252.           char *name;
  1253.      {
  1254.        register int i;
  1255.      
  1256.        for (i = 0; commands[i].name; i++)
  1257.          if (strcmp (name, commands[i].name) == 0)
  1258.            return (&commands[i]);
  1259.      
  1260.        return ((COMMAND *)NULL);
  1261.      }
  1262.      
  1263.      /* Strip whitespace from the start and end of STRING. */
  1264.      stripwhite (string)
  1265.           char *string;
  1266.      {
  1267.        register int i = 0;
  1268.      
  1269.        while (whitespace (string[i]))
  1270.          i++;
  1271.      
  1272.        if (i)
  1273.          strcpy (string, string + i);
  1274.      
  1275.        i = strlen (string) - 1;
  1276.      
  1277.        while (i > 0 && whitespace (string[i]))
  1278.          i--;
  1279.      
  1280.        string[++i] = '\0';
  1281.      }
  1282.      
  1283.      /* **************************************************************** */
  1284.      /*                                                                  */
  1285.      /*                  Interface to Readline Completion                */
  1286.      /*                                                                  */
  1287.      /* **************************************************************** */
  1288.      
  1289.      /* Tell the GNU Readline library how to complete.  We want to try to complete
  1290.         on command names if this is the first word in the line, or on filenames
  1291.         if not. */
  1292.      initialize_readline ()
  1293.      {
  1294.        char **fileman_completion ();
  1295.      
  1296.        /* Allow conditional parsing of the ~/.inputrc file. */
  1297.        rl_readline_name = "FileMan";
  1298.      
  1299.        /* Tell the completer that we want a crack first. */
  1300.        rl_attempted_completion_function = (Function *)fileman_completion;
  1301.      }
  1302.      
  1303.      /* Attempt to complete on the contents of TEXT.  START and END show the
  1304.         region of TEXT that contains the word to complete.  We can use the
  1305.         entire line in case we want to do some simple parsing.  Return the
  1306.         array of matches, or NULL if there aren't any. */
  1307.      char **
  1308.      fileman_completion (text, start, end)
  1309.           char *text;
  1310.           int start, end;
  1311.      {
  1312.        char **matches;
  1313.        char *command_generator ();
  1314.      
  1315.        matches = (char **)NULL;
  1316.      
  1317.        /* If this word is at the start of the line, then it is a command
  1318.           to complete.  Otherwise it is the name of a file in the current
  1319.           directory. */
  1320.        if (start == 0)
  1321.          matches = completion_matches (text, command_generator);
  1322.      
  1323.        return (matches);
  1324.      }
  1325.      
  1326.      /* Generator function for command completion.  STATE lets us know whether
  1327.         to start from scratch; without any state (i.e. STATE == 0), then we
  1328.         start at the top of the list. */
  1329.      char *
  1330.      command_generator (text, state)
  1331.           char *text;
  1332.           int state;
  1333.      {
  1334.        static int list_index, len;
  1335.        char *name;
  1336.      
  1337.        /* If this is a new word to complete, initialize now.  This includes
  1338.           saving the length of TEXT for efficiency, and initializing the index
  1339.           variable to 0. */
  1340.        if (!state)
  1341.          {
  1342.            list_index = 0;
  1343.            len = strlen (text);
  1344.          }
  1345.      
  1346.        /* Return the next name which partially matches from the command list. */
  1347.        while (name = commands[list_index].name)
  1348.          {
  1349.            list_index++;
  1350.      
  1351.            if (strncmp (name, text, len) == 0)
  1352.              return (name);
  1353.          }
  1354.      
  1355.        /* If no names matched, then return NULL. */
  1356.        return ((char *)NULL);
  1357.      }
  1358.      
  1359.      /* **************************************************************** */
  1360.      /*                                                                  */
  1361.      /*                       FileMan Commands                           */
  1362.      /*                                                                  */
  1363.      /* **************************************************************** */
  1364.      
  1365.      /* String to pass to system ().  This is for the LIST, VIEW and RENAME
  1366.         commands. */
  1367.      static char syscom[1024];
  1368.      
  1369.      /* List the file(s) named in arg. */
  1370.      com_list (arg)
  1371.           char *arg;
  1372.      {
  1373.        sprintf (syscom, "ls -FClg %s", arg);
  1374.        system (syscom);
  1375.      }
  1376.      
  1377.      com_view (arg)
  1378.           char *arg;
  1379.      {
  1380.        if (!valid_argument ("view", arg))
  1381.          return;
  1382.      
  1383.        sprintf (syscom, "cat %s | more", arg);
  1384.        system (syscom);
  1385.      }
  1386.      
  1387.      com_rename (arg)
  1388.           char *arg;
  1389.      {
  1390.        too_dangerous ("rename");
  1391.      }
  1392.      
  1393.      com_stat (arg)
  1394.           char *arg;
  1395.      {
  1396.        struct stat finfo;
  1397.      
  1398.        if (!valid_argument ("stat", arg))
  1399.          return;
  1400.      
  1401.        if (stat (arg, &finfo) == -1)
  1402.          {
  1403.            perror (arg);
  1404.            return;
  1405.          }
  1406.      
  1407.        printf ("Statistics for `%s':\n", arg);
  1408.      
  1409.        printf ("%s has %d link%s, and is %d bytes in length.\n", arg,
  1410.                finfo.st_nlink, (finfo.st_nlink == 1) ? "" : "s",  finfo.st_size);
  1411.        printf ("      Created on: %s", ctime (&finfo.st_ctime));
  1412.        printf ("  Last access at: %s", ctime (&finfo.st_atime));
  1413.        printf ("Last modified at: %s", ctime (&finfo.st_mtime));
  1414.      }
  1415.      
  1416.      com_delete (arg)
  1417.           char *arg;
  1418.      {
  1419.        too_dangerous ("delete");
  1420.      }
  1421.      
  1422.      /* Print out help for ARG, or for all of the commands if ARG is
  1423.         not present. */
  1424.      com_help (arg)
  1425.           char *arg;
  1426.      {
  1427.        register int i;
  1428.        int printed = 0;
  1429.      
  1430.        for (i = 0; commands[i].name; i++)
  1431.          {
  1432.            if (!*arg || (strcmp (arg, commands[i].name) == 0))
  1433.              {
  1434.                printf ("%s\t\t%s.\n", commands[i].name, commands[i].doc);
  1435.                printed++;
  1436.              }
  1437.          }
  1438.      
  1439.        if (!printed)
  1440.          {
  1441.            printf ("No commands match `%s'.  Possibilties are:\n", arg);
  1442.      
  1443.            for (i = 0; commands[i].name; i++)
  1444.              {
  1445.                /* Print in six columns. */
  1446.                if (printed == 6)
  1447.                  {
  1448.                    printed = 0;
  1449.                    printf ("\n");
  1450.                  }
  1451.      
  1452.                printf ("%s\t", commands[i].name);
  1453.                printed++;
  1454.              }
  1455.      
  1456.            if (printed)
  1457.              printf ("\n");
  1458.          }
  1459.      }
  1460.      
  1461.      /* Change to the directory ARG. */
  1462.      com_cd (arg)
  1463.           char *arg;
  1464.      {
  1465.        if (chdir (arg) == -1)
  1466.          perror (arg);
  1467.      
  1468.        com_pwd ("");
  1469.      }
  1470.      
  1471.      /* Print out the current working directory. */
  1472.      com_pwd (ignore)
  1473.           char *ignore;
  1474.      {
  1475.        char dir[1024];
  1476.      
  1477.        (void) getwd (dir);
  1478.      
  1479.        printf ("Current directory is %s\n", dir);
  1480.      }
  1481.      
  1482.      /* The user wishes to quit using this program.  Just set DONE non-zero. */
  1483.      com_quit (arg)
  1484.           char *arg;
  1485.      {
  1486.        done = 1;
  1487.      }
  1488.      
  1489.      /* Function which tells you that you can't do this. */
  1490.      too_dangerous (caller)
  1491.           char *caller;
  1492.      {
  1493.        fprintf (stderr,
  1494.                 "%s: Too dangerous for me to distribute.  Write it yourself.\n",
  1495.                 caller);
  1496.      }
  1497.      
  1498.      /* Return non-zero if ARG is a valid argument for CALLER, else print
  1499.         an error message and return zero. */
  1500.      int
  1501.      valid_argument (caller, arg)
  1502.           char *caller, *arg;
  1503.      {
  1504.        if (!arg || !*arg)
  1505.          {
  1506.            fprintf (stderr, "%s: Argument required.\n", caller);
  1507.            return (0);
  1508.          }
  1509.      
  1510.        return (1);
  1511.      }
  1512.  
  1514. File: readline.info,  Node: Concept Index,  Next: Function and Variable Index,  Prev: Programming with GNU Readline,  Up: Top
  1515.  
  1516. Concept Index
  1517. *************
  1518.  
  1519. * Menu:
  1520.  
  1521. * interaction, readline:                Readline Interaction.
  1522. * readline, function:                   Default Behaviour.
  1523.  
  1525. File: readline.info,  Node: Function and Variable Index,  Prev: Concept Index,  Up: Top
  1526.  
  1527. Function and Variable Index
  1528. ***************************
  1529.  
  1530. * Menu:
  1531.  
  1532. * char **completion_matches:            Completion Functions.
  1533. * char *filename_completion_function:   Completion Functions.
  1534. * char *rl_basic_word_break_characters: Completion Variables.
  1535. * char *rl_completer_word_break_characters: Completion Variables.
  1536. * char *rl_line_buffer:                 Function Writing.
  1537. * char *rl_special_prefixes:            Completion Variables.
  1538. * char *username_completion_function:   Completion Functions.
  1539. * Function *rl_attempted_completion_function: Completion Variables.
  1540. * Function *rl_completion_entry_function: How Completing Works.
  1541. * Function *rl_completion_entry_function: Completion Variables.
  1542. * Function *rl_ignore_some_completions_function: Completion Variables.
  1543. * int rl_bind_key:                      Binding Keys.
  1544. * int rl_bind_key_in_map:               Binding Keys.
  1545. * int rl_completion_query_items:        Completion Variables.
  1546. * int rl_end:                           Function Writing.
  1547. * int rl_filename_completion_desired:   Completion Variables.
  1548. * int rl_ignore_completion_duplicates:  Completion Variables.
  1549. * int rl_point:                         Function Writing.
  1550. * int rl_unbind_key:                    Binding Keys.
  1551. * int rl_unbind_key_in_map:             Binding Keys.
  1552. * Keymap rl_copy_keymap:                Keymaps.
  1553. * Keymap rl_make_bare_keymap:           Keymaps.
  1554. * Keymap rl_make_keymap:                Keymaps.
  1555. * readline ():                          Default Behaviour.
  1556. * rl_add_defun:                         Function Naming.
  1557. * rl_begin_undo_group:                  Allowing Undoing.
  1558. * rl_bind_key ():                       Default Behaviour.
  1559. * rl_complete:                          Completion Functions.
  1560. * rl_complete:                          How Completing Works.
  1561. * rl_complete_internal:                 Completion Functions.
  1562. * rl_end_undo_group:                    Allowing Undoing.
  1563. * rl_generic_bind:                      Binding Keys.
  1564. * rl_modifying:                         Allowing Undoing.
  1565. * rl_possible_completions:              Completion Functions.
  1566.  
  1567.  
  1569. Tag Table:
  1570. Node: Top999
  1571. Node: Command Line Editing1612
  1572. Node: Introduction and Notation2035
  1573. Node: Readline Interaction3047
  1574. Node: Readline Bare Essentials4186
  1575. Node: Readline Movement Commands5694
  1576. Node: Readline Killing Commands6585
  1577. Node: Readline Arguments8427
  1578. Node: Readline Init File9378
  1579. Node: Readline Init Syntax10079
  1580. Node: Commands For Moving11547
  1581. Node: Commands For History12172
  1582. Node: Commands For Text13248
  1583. Node: Commands For Killing14915
  1584. Node: Numeric Arguments16042
  1585. Node: Commands For Completion16485
  1586. Node: Miscellaneous Commands17209
  1587. Node: Readline Vi Mode17897
  1588. Node: Programming with GNU Readline19507
  1589. Node: Default Behaviour20212
  1590. Node: Custom Functions23435
  1591. Node: The Function Type24234
  1592. Node: Function Naming24867
  1593. Node: Keymaps26119
  1594. Node: Binding Keys27034
  1595. Node: Function Writing28335
  1596. Node: Allowing Undoing29776
  1597. Node: Custom Completers33278
  1598. Node: How Completing Works34034
  1599. Node: Completion Functions36841
  1600. Node: Completion Variables39174
  1601. Node: A Short Completion Example41951
  1602. Node: Concept Index53534
  1603. Node: Function and Variable Index53823
  1605. End Tag Table
  1606.